Vcenter Vcha Cluster Info
The Vcenter Vcha Cluster Info schema contains the configuration and health information of the three nodes in a VCHA Cluster.
This schema was added in vSphere API 6.7.1.
{
"config_state": "string",
"node1": {
"failover_ip": {
"ip_family": "string",
"ipv4": {
"address": "string",
"subnet_mask": "string",
"prefix": 0
},
"ipv6": {
"address": "string",
"prefix": 0
},
"gateway_ip": "string"
},
"ha_ip": {
"ip_family": "string",
"ipv4": {
"address": "string",
"subnet_mask": "string",
"prefix": 0
},
"ipv6": {
"address": "string",
"prefix": 0
},
"gateway_ip": "string"
},
"runtime": {
"state": "string",
"role": "string",
"placement": {
"management_vcenter_name": "string",
"management_vcenter_server_guid": "string",
"vm_name": "string",
"datacenter": "string",
"datacenter_name": "string",
"host": "string",
"host_name": "string",
"cluster": "string",
"cluster_name": "string",
"ha_network": "string",
"ha_network_name": "string",
"ha_network_type": "string",
"management_network": "string",
"management_network_name": "string",
"management_network_type": "string",
"storage": {
"datastore": "string",
"datastore_name": "string"
},
"bios_uuid": "string"
}
}
},
"node2": {
"failover_ip": {
"ip_family": "string",
"ipv4": {
"address": "string",
"subnet_mask": "string",
"prefix": 0
},
"ipv6": {
"address": "string",
"prefix": 0
},
"gateway_ip": "string"
},
"ha_ip": {
"ip_family": "string",
"ipv4": {
"address": "string",
"subnet_mask": "string",
"prefix": 0
},
"ipv6": {
"address": "string",
"prefix": 0
},
"gateway_ip": "string"
},
"runtime": {
"state": "string",
"role": "string",
"placement": {
"management_vcenter_name": "string",
"management_vcenter_server_guid": "string",
"vm_name": "string",
"datacenter": "string",
"datacenter_name": "string",
"host": "string",
"host_name": "string",
"cluster": "string",
"cluster_name": "string",
"ha_network": "string",
"ha_network_name": "string",
"ha_network_type": "string",
"management_network": "string",
"management_network_name": "string",
"management_network_type": "string",
"storage": {
"datastore": "string",
"datastore_name": "string"
},
"bios_uuid": "string"
}
}
},
"witness": {
"ha_ip": {
"ip_family": "string",
"ipv4": {
"address": "string",
"subnet_mask": "string",
"prefix": 0
},
"ipv6": {
"address": "string",
"prefix": 0
},
"gateway_ip": "string"
},
"runtime": {
"state": "string",
"role": "string",
"placement": {
"management_vcenter_name": "string",
"management_vcenter_server_guid": "string",
"vm_name": "string",
"datacenter": "string",
"datacenter_name": "string",
"host": "string",
"host_name": "string",
"cluster": "string",
"cluster_name": "string",
"ha_network": "string",
"ha_network_name": "string",
"ha_network_type": "string",
"management_network": "string",
"management_network_name": "string",
"management_network_type": "string",
"storage": {
"datastore": "string",
"datastore_name": "string"
},
"bios_uuid": "string"
}
}
},
"mode": "string",
"health_state": "string",
"health_exception": [
{
"id": "string",
"default_message": "string",
"args": [
"string"
],
"params": {
"params": {
"s": "string",
"dt": "string",
"i": 0,
"d": "number",
"l": "Vapi Std NestedLocalizableMessage Object",
"format": "string",
"precision": 0
}
},
"localized": "string"
}
],
"health_warnings": [
{
"error": {
"id": "string",
"default_message": "string",
"args": [
"string"
],
"params": {
"params": {
"s": "string",
"dt": "string",
"i": 0,
"d": "number",
"l": "Vapi Std NestedLocalizableMessage Object",
"format": "string",
"precision": 0
}
},
"localized": "string"
},
"recommendation": {
"id": "string",
"default_message": "string",
"args": [
"string"
],
"params": {
"params": {
"s": "string",
"dt": "string",
"i": 0,
"d": "number",
"l": "Vapi Std NestedLocalizableMessage Object",
"format": "string",
"precision": 0
}
},
"localized": "string"
}
}
],
"manual_failover_allowed": false,
"auto_failover_allowed": false
}Configuration state of the VCHA cluster.
The active node's management vCenter server credentials are not required to populate this property.
For more information see: Vcenter Vcha Cluster ConfigState.
This property was added in vSphere API 6.7.1.
If missing or null, then the information is unavailable.
Node configuration information for the VCHA cluster.
This property was added in vSphere API 6.7.1.
If missing or null, then the information is unavailable.
Node configuration information for the VCHA cluster.
This property was added in vSphere API 6.7.1.
If missing or null, then the information is unavailable or the node is not cloned yet.
Node configuration information for the VCHA cluster.
This property was added in vSphere API 6.7.1.
If missing or null, then the information is unavailable or the node is not cloned yet.
Operational mode of the VCHA Cluster.
For more information see: Vcenter Vcha Cluster ClusterMode.
This property was added in vSphere API 6.7.1.
If missing or null, then the information is unavailable or the node is not cloned yet.
Last known state of the VCHA Cluster.
For more information see: Vcenter Vcha Cluster ClusterState.
This property was added in vSphere API 6.7.1.
If missing or null, then the information is unavailable or the node is not cloned yet.
Health warning messages if the health information is unavailable.
This property was added in vSphere API 6.7.1.
If missing or null, then the cluster is in a healthy state.
A collection of messages describing the reason for a non-healthy Cluster.
This property was added in vSphere API 6.7.1.
If missing or null, then the cluster is in a healthy state.
Specifies if manual failover is allowed.
This property was added in vSphere API 6.7.1.
If missing or null, then the cluster state healthy and manual failover allowance in accordance with the cluster mode.
Specifies if automatic failover is allowed.
This property was added in vSphere API 6.7.1.
If missing or null, then the cluster state healthy and automatic failover allowance in accordance with the cluster mode.